oracle.AWXML
Class Parameter

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Parameter

public class Parameter

extends BaseObject

An object that specifies an action that affects an aggregation or allocation operation over a hierarchy. Every Parameter has a keyword that identifies the action and most have a value that the aggregation or allocation operation uses in effecting the action.

For an aggregation, you can specify one or more Parameter objects for a ConfigurationParameters object and use the ConfigurationParameters as the AggregationArgument for an Aggregation. To create a Parameter for an aggregation operation, use the createParameter method of a ConfigurationParameters.

For an allocation, you can specify one or more Parameter objects for an AllocationArgument for an Allocation. To create a Parameter for an allocation operation, use the createParameter method of an AllocationArgument.

For a table of the keyword and value choices for an aggregation operation, and descriptions of how the choices affect the aggregation, see Parameter Keywords and Values for Aggregation. The following list contains the keywords that you can specify with a Parameter for aggregation.

   DIVIDEBYZERO
   DECIMALOVERFLOW
   NASKIP
   WEIGHTBY

For a table of the keyword and value choices for an allocation operation, and descriptions of how the choices affect the allocation, see Parameter Keywords and Values for Allocation. The following list contain the keywords that you can specify with a Parameter for allocation. Select the keyword to see the entry for it in the table.

   ADD_OR_ASSIGN
   ADD_OR_MULTIPLY
   CEILING
   FLOOR
   MAX
   MIN
   MULTIPLY
   NAHANDLE
   NORMALIZE
   PROTECTLIST
   READWRITE
   WEIGHTBY
   WNAFILL
   WRITE

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

Parameter(BaseObject input)
Creates a new Parameter for the specified ConfigurationParameters or AllocationArgument.

Method Summary

java.lang.String	getKeyWord() Gets the keyword specified for the Parameter.
java.lang.String	getValue() Gets the value specified for the Parameter.
void	setKeyWord(java.lang.String input) Specifies a keyword that identifies the action that the Parameter has on the aggregation or allocation operation.
void	setValue(java.lang.String input) Specifies a value for the Parameter.
java.lang.String	WriteToXML() Gets an XML representation of the Parameter.

Methods inherited from class oracle.AWXML.BaseObject

Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Parameter

public Parameter(BaseObject input)

Creates a new Parameter for the specified ConfigurationParameters or AllocationArgument. An application should create a Parameter by using the createParameter method of a ConfigurationParameters or AllocationArgument.

Parameters:

input - The ConfigurationParameters or AllocationArgument to own the Parameter.

Method Detail

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the Parameter.

Overrides:

WriteToXML in class BaseObject

Returns:

An XML String that represents the Parameter.

setKeyWord

public void setKeyWord(java.lang.String input)

Specifies a keyword that identifies the action that the Parameter has on the aggregation or allocation operation. For a table of the keyword and value choices for an aggregation, see Parameter Keywords and Values for Aggregation. For a table of the keyword and value choices for an allocation, see Parameter Keywords and Values for Allocation.

Parameters:

input - A String that contains the keyword for the Parameter.

getKeyWord

public java.lang.String getKeyWord()

Gets the keyword specified for the Parameter.

Returns:

A String that contains the keyword.

setValue

public void setValue(java.lang.String input)

Specifies a value for the Parameter. The value indicates how the operation effects the action identified by the keyword or it provides information that the operation uses in the action. For example, a Parameter for aggregation can have a keyword of DIVIDEBYZERO and a value that is either YES or NO. A Parameter for allocation can have a keyword of MAX and a value that designates the maximum value to use in the allocation.

All Parameter objects for an aggregation operation require a value. For an allocation operation, most Parameter objects require a value.

For a table of the keyword and value choices for an aggregation, see Parameter Keywords and Values for Aggregation. For a table of the keyword and value choices for an allocation, see Parameter Keywords and Values for Allocation.

Parameters:

input - A String that contains the value for the Parameter.

getValue

public java.lang.String getValue()

Gets the value specified for the Parameter.

Returns:

A String that contains the value.